home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / cgbtf2.z / cgbtf2
Encoding:
Text File  |  2002-10-03  |  4.9 KB  |  133 lines
  1.  
  2.  
  3.  
  4. CCCCGGGGBBBBTTTTFFFF2222((((3333SSSS))))                                                          CCCCGGGGBBBBTTTTFFFF2222((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CGBTF2 - compute an LU factorization of a complex m-by-n band matrix A
  10.      using partial pivoting with row interchanges
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CGBTF2( M, N, KL, KU, AB, LDAB, IPIV, INFO )
  14.  
  15.          INTEGER        INFO, KL, KU, LDAB, M, N
  16.  
  17.          INTEGER        IPIV( * )
  18.  
  19.          COMPLEX        AB( LDAB, * )
  20.  
  21. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  22.      These routines are part of the SCSL Scientific Library and can be loaded
  23.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  24.      directs the linker to use the multi-processor version of the library.
  25.  
  26.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  27.      4 bytes (32 bits). Another version of SCSL is available in which integers
  28.      are 8 bytes (64 bits).  This version allows the user access to larger
  29.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  30.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  31.      only one of the two versions; 4-byte integer and 8-byte integer library
  32.      calls cannot be mixed.
  33.  
  34. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  35.      CGBTF2 computes an LU factorization of a complex m-by-n band matrix A
  36.      using partial pivoting with row interchanges. This is the unblocked
  37.      version of the algorithm, calling Level 2 BLAS.
  38.  
  39.  
  40. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  41.      M       (input) INTEGER
  42.              The number of rows of the matrix A.  M >= 0.
  43.  
  44.      N       (input) INTEGER
  45.              The number of columns of the matrix A.  N >= 0.
  46.  
  47.      KL      (input) INTEGER
  48.              The number of subdiagonals within the band of A.  KL >= 0.
  49.  
  50.      KU      (input) INTEGER
  51.              The number of superdiagonals within the band of A.  KU >= 0.
  52.  
  53.      AB      (input/output) COMPLEX array, dimension (LDAB,N)
  54.              On entry, the matrix A in band storage, in rows KL+1 to
  55.              2*KL+KU+1; rows 1 to KL of the array need not be set.  The j-th
  56.              column of A is stored in the j-th column of the array AB as
  57.              follows:  AB(kl+ku+1+i-j,j) = A(i,j) for max(1,j-
  58.              ku)<=i<=min(m,j+kl)
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCGGGGBBBBTTTTFFFF2222((((3333SSSS))))                                                          CCCCGGGGBBBBTTTTFFFF2222((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              On exit, details of the factorization: U is stored as an upper
  75.              triangular band matrix with KL+KU superdiagonals in rows 1 to
  76.              KL+KU+1, and the multipliers used during the factorization are
  77.              stored in rows KL+KU+2 to 2*KL+KU+1.  See below for further
  78.              details.
  79.  
  80.      LDAB    (input) INTEGER
  81.              The leading dimension of the array AB.  LDAB >= 2*KL+KU+1.
  82.  
  83.      IPIV    (output) INTEGER array, dimension (min(M,N))
  84.              The pivot indices; for 1 <= i <= min(M,N), row i of the matrix
  85.              was interchanged with row IPIV(i).
  86.  
  87.      INFO    (output) INTEGER
  88.              = 0: successful exit
  89.              < 0: if INFO = -i, the i-th argument had an illegal value
  90.              > 0: if INFO = +i, U(i,i) is exactly zero. The factorization has
  91.              been completed, but the factor U is exactly singular, and
  92.              division by zero will occur if it is used to solve a system of
  93.              equations.
  94.  
  95. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  96.      The band storage scheme is illustrated by the following example, when M =
  97.      N = 6, KL = 2, KU = 1:
  98.  
  99.      On entry:                       On exit:
  100.  
  101.          *    *    *    +    +    +       *    *    *   u14  u25  u36
  102.          *    *    +    +    +    +       *    *   u13  u24  u35  u46
  103.          *   a12  a23  a34  a45  a56      *   u12  u23  u34  u45  u56
  104.         a11  a22  a33  a44  a55  a66     u11  u22  u33  u44  u55  u66
  105.         a21  a32  a43  a54  a65   *      m21  m32  m43  m54  m65   *
  106.         a31  a42  a53  a64   *    *      m31  m42  m53  m64   *    *
  107.  
  108.      Array elements marked * are not used by the routine; elements marked +
  109.      need not be set on entry, but are required by the routine to store
  110.      elements of U, because of fill-in resulting from the row
  111.      interchanges.
  112.  
  113.  
  114. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  115.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  116.  
  117.      This man page is available only online.
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.